You are now reading Apple DocViewer User’s Guide. Apple DocViewer is an application that lets you display, read, and search documentation on your monitor screen. It also lets you copy text and graphics to other applications and print part or all of any document.
DocViewer reads only viewer documents marked by the icon. Apple has created these documents from the original text files using a special program.
To go through this guide page by page, click the up or down arrows at the bottom left of the Document window (the window displaying this text). If your monitor does not show a full page, use the scroll bars to move around within each page.
To quit DocViewer, type Command-Q or select Quit form the File menu.
Viewer Features
When DocViewer is active you will see its menus in the menu bar. Here’s a brief summary of what these menus help you do:
The File menu lets you open and close viewer documents, export text, print viewer documents, and set certain viewing preferences. It also lets you bind documents so they are automatically listed in the Catalog of open documents that your copy of DocViewer maintains.
Apple, Macintosh, MultiFinder, and A/UX are registered trademarks of Apple Computer, Inc.
Apple DocViewer and Finder are trademarks of Apple Computer, Inc.
FrameMaker is a registered trademark of Frame Technology Corporation.
Adobe Illustrator is a registered trademark of Adobe Systems Incorporated.
n The Edit menu helps you select and copy text or graphics from a viewer document to the Clipboard. From the Clipboard you can paste the copied material into documents running under other applications.
n The Navigation menu helps you move from page to page within the document you are currently viewing (the active document). Additional navigation controls are located at the edges of DocViewer’s Document window.
n The Search menu helps you find specific words or phrases in the text of one or more viewer documents.
n The Bookmark menu lets you mark places in a document with your own labels.
n The Outlines menu lets you see the Catalog of open documents or the Book Index that applies to the active document. It lets you collapse and expand the levels of detail in either of these lists. You can easily go to specific places in the active document by double-clicking lines in the Catalog or the Book Index.
n The Windows menu lets you move from one document to another when you have multiple documents open in DocViewer.
The rest of this guide explains these features in more detail.
At the end of this guide is a section that lists all the DocViewer menu commands and their key equivalents. If you use DocViewer often, you may want to print this section and post it near your monitor.
The DocViewer Environment
DocViewer runs on all models of the Macintosh computer from the Macintosh Plus onward. It runs under versions 6.0.5 and later of the Macintosh system software, including System 7. You must run it from a local hard disk or CD-ROM, not from a server. DocViewer requires at least 1024K of RAM.
Your system may need specific fonts to display or print certain viewer documents correctly. Required fonts are normally specified in a Read Me file that accompanies viewer documents or sets of documents. If you are not using System 7, your system should use the TrueType system extension. For best viewing results, both bitmap and TrueType fonts should be installed in your system.
The DocViewer application takes about 400K of disk space.
Viewing and Printing
DocViewer reads only viewer files—ones that Apple has previously constructed from word processor files.
You can open a viewer document several ways:
n If DocViewer is not running, use the Finder to open the document.
n If DocViewer is running, use the Finder or select Open from the File menu and double-click the document’s name.
n If DocViewer is running and the document is bound, double-click its name in the Catalog. Bound documents are explained on page 14; the Catalog is discussed on page 13.
n All documents that are bound and open when you quit DocViewer will automatically open the next time you launch the application.
To close a viewer document, click the close box or select Close from the File menu.
Sometimes graphics in a viewer document are scaled to fit the page. To see a graphic in its original size, double-click it.
Documents open in DocViewer are read-only, so several users can access the same document at the same time from a file server. Do not try to run DocViewer itself from a server, however.
Colored text in the original version of a viewer document will appear on your screen if you have a color monitor.
Controlling the Document View
The following illustration identifies the controls around the Document window.
Figure 1-1 Document window controls
n The Bookmarks pop-up menu gives you a list of existing bookmarks. To go to a marked place, select an item in the menu. Bookmarks are discussed on page 16.
n The text selection tool lets you select text by dragging, double-clicking, shift-clicking, or by holding down the Shift key when using the arrow cursor control keys.
n The box selection tool lets you select a rectangular area of text or graphics or both by dragging a box over it.
n The lasso selection tool lets you select an irregular area of text or graphics or both by drawing a closed line around it.
n The single-page display button presents the active document one page at a time.
n The double-page display button presents two facing pages. Paging commands shift two pages at a time.
n The continuous display button presents pages end to end. You can use the vertical scroll bar to go through an entire document.
n The text-only display button presents pages of plain text without formatting. Each graphic is replaced by a button that you can click to view it in a separate window. This display mode is described on page 8.
n The size pop-up menu lets you select any enlargement or reduction for viewing the document, in a continuous range from 25% to 400%.
n The page indicator tells you what page in the document you are viewing. The page number outside the parentheses is the printed page number; the page number inside the parentheses is the sequential page number. Use the sequential page number in the Print command (described on page 11) to specify the range of pages you want printed. If you click the page indicator, it opens the Go To dialog box (described on page 21).
n The page-arrow buttons let you move backwards and forwards in the document one page at a time.
n The scroll bars let you move around inside a page. If you have selected the continuous display mode, the vertical scroll bar lets you move through the document.
n If you have an extended keyboard, you can use its Page Up and Page Down keys to scroll up or down one screen at a time.
The Windows menu lists all windows currently open, including the Catalog, Book, Query, and Index windows as well as all Document windows.
Setting View Preferences
The Preferences dialog box, accessible by choosing Preferences from the File menu, lets you set the default size and type of display for the active document. These settings will apply the next time you open that document. Figure 2 shows the Preferences dialog box.
Figure 1-2 Preferences dialog box
The Preferences dialog box also lets you set the speed at which the scroll bar arrows move all documents—from 1 pixel-per-click (slow) to 100 pixels-per-click (fast).
Your preference settings are recorded in a file named “AppleDocViewer.Pref”. It must be in the Preferences folder in the System folder. The file also records bookmarks, catalog information, Page Setup command choices, font styles for text-only mode, and the positions to which you moved various viewer windows.
Text-Only Display
Choosing text-only display removes the formatting from the document. Each level of heading in the document still has text formats, and you can set these formats using the Format command from the Edit menu. In text-only display, the text automatically re-wraps as you resize the window. Because of this, you may find that text-only view is more convenient if the document is formatted for screens wider than yours.
Selecting Text and Graphics
You must select text before copying it, designating it as a place for a new bookmark, or finding the same text elsewhere in the viewer document.
To select text, highlight the text selection tool and follow the standard Macintosh text selection rules:
n To select a single word, double-click it.
n To select a run of text, drag over it or shift-click the ends of it.
You can also move the insertion point with the arrow keys and select by holding down the Shift key while using the arrow keys.
You must select a graphic before copying it, by highlighting the box or lasso selection tool and drawing a line around the graphic. You can select all or any part of a graphic in the Document window. You cannot select within a separate graphic window.
Copying From a Viewer Document
The Copy command in the Edit menu lets you copy any selected text or graphic material out of the active viewer document into the Clipboard.
To view the contents of the Clipboard, choose Show Clipboard from the Edit menu.
Text is copied as a plain character stream—with tab characters but without tabbing instructions, graphics, typographic styling, hidden text, or elements supplied by templates.
Graphic material is copied in PICT format. If you include text in a graphic selection (such as the caption with a figure), it is copied graphically, not as text.
You can move to a document in another application (such as a word processor or development system) and use the Paste command to write out the contents of the Clipboard. In this way you can copy viewer material into any application that pastes from the Clipboard. For example, copying and pasting from DocViewer lets you transfer code samples from New Inside Macintosh into your development system.
You cannot change a viewer document or import anything into it. You can, however, export the text in the document to a file. Choose Export Text from the File menu to export all the text in the DocViewer file to a text-only file.
Printing a Viewer Document
You can print any page range in a viewer document by using the Print commands in the File menu: Page Setup, Print One, and Print.
Page Setup gives you the standard Page Setup dialog box. The correct page setup settings for a viewer document are usually specified in its Read Me file.
Print One prints only the visible portion of the active document, which may be more than one page if you are in double-page or continuous display mode. It can also print the contents of any selected window.
Print lets you select a page range and other print characteristics. You can also choose whether to print all pages, just odd pages, or just even pages; the latter choices are useful if you want to print on both sides of the paper. If you specify a range of sequential page numbers, the dialog box is updated to show you the page numbers in the document’s numbering scheme you have selected.
Figure 1-3 Print dialog box
If you are not printing the entire document, you can determine which sequential page numbers to print by navigating to the beginning and end of the desired range. The sequential page numbers are shown in parentheses in the lower left corner of the window.
Navigation
DocViewer provides five ways to navigate within and among documents:
n The Catalog lists all open documents and the main structural elements within those documents. You can go to a document, chapter, section, figure, or table by double-clicking its name in the Catalog. You can bind any document to the Catalog so it opens every time you use DocViewer. You can filter titles in the Catalog so they appear only if they contain a specified keyword.
n The Book Index displays the active document’s index. Double-clicking an index entry takes you to that reference in the document. You can filter entries in the Book Index so they appear only if they contain a specified keyword.
n The Bookmarks pop-up menu (at the upper left of the Document window) displays labels you have given to specific places in the document. You can go to the labeled text by choosing its name in the menu.
n The Search menu lets you search the text of the active document for specific words or phrases. It also lets you query one or more documents for complex word combinations and constructs a list of all the places where they occur.
n The Navigation menu provides several ways to find specific pages or sections in the active document.
Using the Catalog
To see the Catalog for your copy of DocViewer, choose Open Catalog from the Outlines menu.
Every line in the Catalog has a name and an icon. If the line designates a document or section that contains subsections, it also has a subsection triangle. You can use the Catalog by clicking a name, triangle, or icon as follows:
n Double-clicking a name takes you to that document, section, figure, or table. You can also click the name to select it and then press Enter.
n Clicking a right-pointing triangle expands the subsections within that section.
n Clicking a down-pointing triangle collapses the immediate subsections.
n Holding down the Option key while double-clicking an icon or a name opens a subcatalog window that shows the subsections in that section. In this case, a second catalog window with the subsections is opened.
Figure 1-4 A typical Catalog
Special keyboard equivalents for Catalog actions are listed on page 22.
To expand the whole Catalog, choose Expand All from the Outlines menu. To collapse it, choose Collapse All.
To change the document levels displayed when the Catalog is expanded, choose Catalog Level from the Outlines menu.
To remove all open subcatalog windows, choose Close Subcatalogs from the Outlines menu.
You can list any number of documents in the Catalog and you can open up to 10 documents at one time.
Binding a Document
Binding a document to your copy of DocViewer makes it automatically appear in the Catalog every time you open the application. A bound document has a filled-in icon that looks like a closed book; a document that is currently open but not bound has an outlined icon that looks like an open book.
To bind the active document (the one you are currently viewing), choose Bind Document from the File menu; to unbind it, choose Unbind Document.
A document must be bound for you to set bookmarks in it. When you unbind a document, you lose all its bookmarks.
Using the Book Index
To see the index for the active document, choose Book Index from the Outlines menu. You cannot open an index unless the document to which it applies is showing in the active window. If the index window is empty, the document was created without any index entries.
The index opens in collapsed form, showing only index letters. To expand or collapse the index, do the following:
n To see the subentries for one letter or entry, click the right-pointing triangle beside that letter.
n To collapse index entries at any point, click a down-pointing triangle.
n To expand the whole index, choose Expand All from the Outlines menu. To collapse it, choose Collapse All.
To use the index, double-click an entry. This takes you to the first place in the document referenced by that entry.
After you have gone to the first place in the document referenced by an index entry, you can go to subsequent places for the same entry by choosing Next Reference from the Outlines menu. To go back to previous places, hold down the Shift key while you choose Next Reference.
Filtering the Catalog or Book Index
You can use the Filter function at the top of the Catalog or Book Index window to show only those entries that contain a keyword string.
To filter the Catalog or any index, type a string in the Filter window and click Apply. Lines in the window that don’t contain that string will disappear. To restore the full list, empty the Filter window and click Apply again.
The filter function treats keywords as literal, not just whole words. For example, if you use “event” as a keyword the filter function will accept words such as “prevent.”
Creating and Using Bookmarks
If the active document has been bound to your copy of DocViewer, you can attach your own labels to places in it by using commands in the Bookmarks pop-up menu, as follows:
1. Select a piece of text in the active document. To place a bookmark on a figure, select its text caption.
2. Choose Set from the Bookmark menu. The first 63 characters of the selected text will appear as the default label. If you want a different label (up to 63 characters long), type it now.
3. Click the Set button.
After you have created a bookmark, it appears in the menu that pops up when you click Bookmarks in the upper left corner of the Document window. Choosing a line in the Bookmarks pop-up menu takes you to the page you marked in the document and highlights the text you labeled.
To delete a bookmark, choose Delete from the Bookmark menu. In the dialog box that appears, click the name of the bookmark you want to delete.
To rename a bookmark, choose it from the Bookmarks pop-up menu in the Document window, then choose Rename from the Bookmark menu in the menu bar.
To list all bookmarks alphabetically (including new ones), choose Alphabetical from the Bookmark menu.
To turn off alphabetizing, choose Alphabetical a second time. Bookmarks will be listed in the order of the pages in the document to which they point.
Only bound documents can accept bookmarks, and if you unbind a document you lose all its bookmarks. Binding and unbinding are discussed on page 14.
Finding Text
When you choose Find from the Search menu, a dialog box appears. You can enter a string of text characters and ask DocViewer to find the first occurrence of that string beyond the current selection or insertion point in the text. The Find dialog box has several options:
n Literal finds the string wherever it occurs—for example, finding “event” within “prevented.” Entire Word finds the string only if the string occurs as a word by itself. Words are defined as continuous strings of letters, numbers, and underscore characters.
n Search Backwards finds the first occurrence before the current insertion point.
n Wrap-Around Search continues the search at the other end of the file after it has reached one end, ensuring that your entire file is searched.
n Case-Sensitive restricts the search to strings with identical capitalization. For example, a search for “event” will not find “Event.”
To find the first occurrence of a string after the current insertion point, click the Find button. DocViewer takes you to that page and highlights the string.
When you choose Find Again from the Search menu, DocViewer finds the next occurrence of the string after the one just found.
When you choose Find Selection, DocViewer searches for the next occurrence of the currently selected text.
If you hold down the Shift key while choosing Find Again or Find Selection, DocViewer searches backward for the previous occurrence.
To stop a lengthy find operation, press Command-period.
When you choose Find Again or Find Selection, the Find options (Literal, Backwards, Wrap-Around, Case-Sensitive) remain as previously set.
Listing Text Structures
When you choose Query from the Search menu, DocViewer prepares a list of all occurrences of a specified text structure within a document or set of documents. In the A/UX world, such a list is sometimes called a permuted index. The Query dialog box looks like:
Figure 1-5 Query dialog box
The Query function lets you locate subjects or related ideas for which you can’t easily define a Find operation. It follows these rules:
n It works only if there is an index file for each document being searched and that file is in the same folder as the document file. Index files are created at the same time as viewer documents and are identified by the suffix .idx. They are not related to the document’s Book Index.
n Strings being searched for must contain at least one “significant” word, such as a technical term; you cannot search for a string such as “whatever,” “with which,” or “as in the.”
n The Query search will find all combinations of the significant words in the string being searched for.
n You can search only for entire words or combinations of entire words.
n All Query searches ignore the difference between uppercase and lowercase.
n In most cases, a search for the singular form of a word will also find the plural form but a search for the plural form will not find the singular.
n Distances between words count the first one, so adjacent words are counted as being one word apart.
Numbers in the left margin of the list tell you how many “hits” DocViewer has found in each section or document.
The More Options button lets you view a dialog box that shows all the Query options. Clicking Fewer Options hides the more complex choices.
Here’s how to use the Query function with its basic options:
1. Enter the string you want to find in the “Search for” field.
2. Using the search pop-up menu, you can choose to search all documents in the Catalog (including bound documents that are not open), all open documents, or only the active document.
3. If you check the Show Context button, DocViewer lists each hit and the wording surrounding it. When the Show Context button is not checked, DocViewer only lists the sections where the string was found and the number of hits in that section.
4. Click the Search button. After DocViewer has finished, you can choose Expand All from the Outlines menu to view the complete list.
5. To go to a reference in the original document, click that line in the list.
6. To go to the next reference in the list, choose Next Occurrence from the Search menu.
7. To go to the previous reference, choose Next Occurrence while holding down the Shift key.
The More Options feature gives you two formulas for narrowing choices:
n The “<In / not in> the same <paragraph / section> as” formula lets you narrow the search to a specific combination of strings in the same part of a document. Enter the second string in the field and tailor the formula by using the pop-up menus.
n The “<Within / not within> <nn> words of” formula narrows the search to combinations in which another string occurs or does not occur near the basic string searched for. The number you enter in the formula for the word distance <nn> may run from 1 to 9000.
To empty your choices from the Query dialog box, click the Clear button.
Closing a document removes its entries from the list generated by the Query function.
Using the Navigation Menu
The Navigation menu gives you several ways to go from page to page in the active document:
n The First Page, Last Page, Previous Page, and Next Page commands take you to those pages of the active document. If you are viewing the document in Double-page Display Mode, Previous and Next make two-page moves. If you have an extended keyboard you can also use its Home and End keys to take you to the first and last pages of the active document.
n The Previous Heading and Next Heading commands take you to the previous or next subhead at any level.
n The Go To command displays a dialog box that lets you enter a page number to go to. The page number must be written exactly as it appears in the active document—for example, 37 or 5-20 or ix.
n The Display Selection command takes you to the page where text is currently selected or where the text insertion point is currently located.
n The Go Forward and Go Backward commands refer to a navigation record that DocViewer maintains. As you move from page to page, it records the last 16 pages you have viewed. The go commands take you back and forth along this personal route. For example, if you have most recently viewed pages 5, then 12, then 8, choosing Go Backward once will take you from 8 back to 12; choosing it a second time will take you from 12 back to 5. Two Go Forward commands will then return you from 5 to 8.
You can also move from page to page in the active document by using the page-up and page-down arrows in the lower left corner of the Document window.
Keyboard Equivalents
Many of DocViewer’s menu items have keyboard equivalents. Here is a list of them.
Menu Item(continued) Key(continued)
Close Window Command-W
Close Subcatalogs Command-H
Copy Command-C
Cut Command-X
Expand All Command-E
Find Again Command-G
Find Again Backward Command-Shift-G
Find Selection Command-H
Find Selection Backward Command-Shift-H
Find Command-F
First Page Command-1 or Home (extended keyboard)
Go Backward Command-[
Go Forward Command-]
Go To Command-N
Last Page Command-4 or End (extended keyboard)
continued
Next Heading Command-6
Next Occurrence Command-U
Next Page Command-3
Next Reference Command-R
Open Catalog Command-L
Open Book Index Command-I
Open Command-O
Paste Command-V
Previous Heading Command-5
Previous Page Command-2
Previous Occurrence Command-Shift-U
Previous Reference Command-Shift-R
Print Command-P
Query Command-Y
Quit DocViewer Command-Q
Set Bookmark Command-M
Undo Command-Z
You can use a special set of keyboard equivalents to navigate the Catalog.
Catalog Action Key
Collapse all sections Command-D
Collapse section Command-Left Arrow
Collapse section and subsections Command-Option-Left Arrow
Expand all sections Command-E
Expand section Command-Right Arrow
Expand section and subsections Command-Option-Right Arrow
Go to reference in document Enter
Open Subcatalog window Command-Down Arrow
About the User’s Guide
This Apple online manual was written, edited, and composed on a desktop publishing system using Apple Macintosh computers and FrameMaker software. Line art was created using Adobe Illustrator.
Text type is Palatino and display type is Helvetica. Some material, such as file names, is set in Apple Courier.
WRITERS
George Towner, Paul Hoffman
DEVELOPMENTAL EDITOR
Sanborn Hodgkins
Wendy Krafft
ART DIRECTOR
Barbara Smyth
PRODUCTION EDITOR
Gerri Gray
SPECIAL THANKS TO
Mark Bloomquist, In-Yung Kim, Hayden Harman, David Krathwohl,
Henri Lamiraux, Tess Lujan, Randy Matamoros, Harry Saddler, John Schmidli, Brigham Stevens, Bonnie Umphreys, and Doris Wells-Papanek